|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.Platform
The central class of the Eclipse Platform Runtime. This class cannot be instantiated or subclassed by clients; all functionality is provided by static methods. Features include:
The platform is in one of two states, running or not running, at all
times. The only ways to start the platform running, or to shut it down,
are on the bootstrap BootLoader
class. Code in plug-ins will
only observe the platform in the running state. The platform cannot
be shutdown from inside (code in plug-ins have no access to
BootLoader
).
Field Summary | |
static int |
FAILED_DELETE_METADATA
Status code constant (value 6) indicating the platform could not delete some of its metadata. |
static int |
FAILED_READ_METADATA
Status code constant (value 4) indicating the platform could not read some of its metadata. |
static int |
FAILED_WRITE_METADATA
Status code constant (value 5) indicating the platform could not write some of its metadata. |
static int |
INTERNAL_ERROR
Status code constant (value 3) indicating an error internal to the platform has occurred. |
static int |
MAX_PERFORMANCE
Constant (value 5) indicating the maximum allowed value for the PREF_PLATFORM_PERFORMANCE preference setting. |
static int |
MIN_PERFORMANCE
Constant (value 1) indicating the minimum allowed value for the PREF_PLATFORM_PERFORMANCE preference setting. |
static String |
OPTION_STARTTIME
Debug option value denoting the time at which the platform runtime was started. |
static int |
PARSE_PROBLEM
Status code constant (value 1) indicating a problem in a plug-in manifest ( plugin.xml ) file. |
static String |
PI_BOOT
|
static String |
PI_RUNTIME
The unique identifier constant (value " org.eclipse.core.runtime ")
of the Core Runtime (pseudo-) plug-in. |
static int |
PLUGIN_ERROR
Status code constant (value 2) indicating an error occurred while running a plug-in. |
static String |
PREF_PLATFORM_PERFORMANCE
Name of a preference for configuring the performance level for this system. |
static String |
PT_APPLICATIONS
The simple identifier constant (value " applications ") of
the extension point of the Core Runtime plug-in where plug-ins declare
the existence of runnable applications. |
Method Summary | |
static void |
addAuthorizationInfo(URL serverUrl,
String realm,
String authScheme,
Map info)
Adds the given authorization information to the keyring. |
static void |
addLogListener(ILogListener listener)
Adds the given log listener to the notification list of the platform. |
static void |
addProtectionSpace(URL resourceUrl,
String realm)
Adds the specified resource to the protection space specified by the given realm. |
static URL |
asLocalURL(URL url)
Returns a URL which is the local equivalent of the supplied URL. |
static void |
endSplash()
Takes down the splash screen if one was put up. |
static URL |
find(org.osgi.framework.Bundle bundle,
IPath path)
Returns a URL for the given path in the given bundle. |
static URL |
find(org.osgi.framework.Bundle b,
IPath path,
Map override)
Returns a URL for the given path in the given bundle. |
static void |
flushAuthorizationInfo(URL serverUrl,
String realm,
String authScheme)
Removes the authorization information for the specified protection space and given authorization scheme. |
static IAdapterManager |
getAdapterManager()
Returns the adapter manager used for extending IAdaptable objects. |
static String[] |
getAllArgs()
Returns all command line arguments specified when the running framework was started. |
static String[] |
getApplicationArgs()
Returns the arguments not consumed by the framework implementation itself. |
static Map |
getAuthorizationInfo(URL serverUrl,
String realm,
String authScheme)
Returns the authorization information for the specified protection space and given authorization scheme. |
static String[] |
getCommandLineArgs()
Returns the command line args provided to the platform when it was first run. |
static String |
getDebugOption(String option)
Returns the identified option. |
static IExtensionRegistry |
getExtensionRegistry()
Returns the extension registry for this platform. |
static String[] |
getFrameworkArgs()
Returns the arguments consumed by the framework implementation itself. |
static IJobManager |
getJobManager()
Returns the platform job manager. |
static IPath |
getLocation()
Returns the location of the platform working directory. |
static ILog |
getLog(org.osgi.framework.Bundle bundle)
Returns the log for the given bundle. |
static IPath |
getLogFileLocation()
Returns the location of the platform log file. |
static String |
getNL()
Returns the string name of the current locale for use in finding files whose path starts with $nl$ . |
static String |
getOS()
Returns the string name of the current operating system for use in finding files whose path starts with $os$ . |
static String |
getOSArch()
Returns the string name of the current system architecture. |
static Plugin |
getPlugin(String id)
Returns the plug-in runtime object for the identified plug-in or null if no such plug-in can be found. |
static IPluginRegistry |
getPluginRegistry()
Returns the plug-in registry for this platform. |
static IPath |
getPluginStateLocation(Plugin plugin)
Returns the location in the local file system of the plug-in state area for the given plug-in. |
static String |
getProtectionSpace(URL resourceUrl)
Returns the protection space (realm) for the specified resource, or null if the realm is unknown. |
static ResourceBundle |
getResourceBundle(org.osgi.framework.Bundle bundle)
Returns the given bundle's resource bundle for the current locale. |
static String |
getResourceString(org.osgi.framework.Bundle bundle,
String value)
Returns a resource string corresponding to the given argument value. |
static String |
getResourceString(org.osgi.framework.Bundle bundle,
String value,
ResourceBundle resourceBundle)
Returns a resource string corresponding to the given argument value and resource bundle in the given runtime bundle. |
static IPath |
getStateLocation(org.osgi.framework.Bundle bundle)
Returns the location in the local file system of the plug-in state area for the given bundle. |
static String |
getWS()
Returns the string name of the current window system for use in finding files whose path starts with $ws$ . |
static InputStream |
openStream(org.osgi.framework.Bundle bundle,
IPath file)
Returns an input stream for the specified file in the given bundle. |
static InputStream |
openStream(org.osgi.framework.Bundle bundle,
IPath file,
boolean localized)
Returns an input stream for the specified file in the given bundle. |
static void |
removeLogListener(ILogListener listener)
Removes the indicated (identical) log listener from the notification list of the platform. |
static URL |
resolve(URL url)
Returns a URL which is the resolved equivalent of the supplied URL. |
static void |
run(ISafeRunnable runnable)
Runs the given runnable in a protected mode. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String PI_RUNTIME
org.eclipse.core.runtime
")
of the Core Runtime (pseudo-) plug-in.
public static final String PI_BOOT
public static final String PT_APPLICATIONS
applications
") of
the extension point of the Core Runtime plug-in where plug-ins declare
the existence of runnable applications. A plug-in may define any
number of applications; however, the platform is only capable
of running one application at a time.
org.eclipse.core.boot.BootLoader#run
,
Constant Field Valuespublic static final String OPTION_STARTTIME
getDebugOption
to find the string value of
System.currentTimeMillis()
when the platform was started.
public static final String PREF_PLATFORM_PERFORMANCE
This value can be used by all components to customize features to suit the speed of the user's machine. The platform job manager uses this value to make scheduling decisions about background jobs.
The preference value must be an integer between the constant values MIN_PERFORMANCE and MAX_PERFORMANCE
MIN_PERFORMANCE
,
MAX_PERFORMANCE
,
Constant Field Valuespublic static final int MIN_PERFORMANCE
PREF_PLATFORM_PERFORMANCE
preference setting.
public static final int MAX_PERFORMANCE
PREF_PLATFORM_PERFORMANCE
preference setting.
public static final int PARSE_PROBLEM
plugin.xml
) file.
public static final int PLUGIN_ERROR
public static final int INTERNAL_ERROR
public static final int FAILED_READ_METADATA
public static final int FAILED_WRITE_METADATA
public static final int FAILED_DELETE_METADATA
Method Detail |
public static void addAuthorizationInfo(URL serverUrl, String realm, String authScheme, Map info) throws CoreException
Map
of String
to String
and typically
contains information such as usernames and passwords.
serverUrl
- the URL identifying the server for this authorization
information. For example, "http://www.example.com/".realm
- the subsection of the given server to which this
authorization information applies. For example,
"realm1@example.com" or "" for no realm.authScheme
- the scheme for which this authorization information
applies. For example, "Basic" or "" for no authorization schemeinfo
- a Map
containing authorization information
such as usernames and passwords (key type : String
,
value type : String
)
CoreException
- if there are problems setting the
authorization information. Reasons include:
public static void addLogListener(ILogListener listener)
Once registered, a listener starts receiving notification as entries
are added to plug-in logs via ILog.log()
. The listener continues to
receive notifications until it is replaced or removed.
listener
- the listener to registerILog.addLogListener(org.eclipse.core.runtime.ILogListener)
,
removeLogListener(org.eclipse.core.runtime.ILogListener)
public static void addProtectionSpace(URL resourceUrl, String realm) throws CoreException
resourceUrl
- the URL identifying the resources to be added to
the specified protection space. For example,
"http://www.example.com/folder/".realm
- the name of the protection space. For example,
"realm1@example.com"
CoreException
- if there are problems setting the
authorization information. Reasons include:
public static URL asLocalURL(URL url) throws IOException
url
- original plug-in-relative URL.
IOException
- if unable to resolve URLresolve(java.net.URL)
,
IPluginDescriptor.getInstallURL()
public static void endSplash()
public static void flushAuthorizationInfo(URL serverUrl, String realm, String authScheme) throws CoreException
serverUrl
- the URL identifying the server to remove the
authorization information for. For example,
"http://www.example.com/".realm
- the subsection of the given server to remove the
authorization information for. For example,
"realm1@example.com" or "" for no realm.authScheme
- the scheme for which the authorization information
to remove applies. For example, "Basic" or "" for no
authorization scheme.
CoreException
- if there are problems removing the
authorization information. Reasons include:
public static IAdapterManager getAdapterManager()
IAdaptable
objects.
IAdapterManager
public static Map getAuthorizationInfo(URL serverUrl, String realm, String authScheme)
null
if no
such information exists.
serverUrl
- the URL identifying the server for the authorization
information. For example, "http://www.example.com/".realm
- the subsection of the given server to which the
authorization information applies. For example,
"realm1@example.com" or "" for no realm.authScheme
- the scheme for which the authorization information
applies. For example, "Basic" or "" for no authorization scheme
null
if no
such information existspublic static String[] getCommandLineArgs()
Platform.run()
.
public static String getDebugOption(String option)
null
is returned if no such option is found. Options are specified
in the general form <plug-in id>/<option-path>.
For example, org.eclipse.core.runtime/debug
option
- the name of the option to lookup
null
public static IPath getLocation()
public static IPath getLogFileLocation()
public static Plugin getPlugin(String id)
null
if no such plug-in can be found. If
the plug-in is defined but not yet activated, the plug-in will
be activated before being returned.
Note: This is obsolete API that will be replaced in time with the OSGI-based Eclipse Platform Runtime introduced with Eclipse 3.0. This API will be deprecated once the APIs for the new Eclipse Platform Runtime achieve their final and stable form (post-3.0).
id
- the unique identifier of the desired plug-in
(e.g., "com.example.acme"
).
null
public static IPluginRegistry getPluginRegistry()
Note: This is obsolete API that will be replaced in time with the OSGI-based Eclipse Platform Runtime introduced with Eclipse 3.0. This API will be deprecated once the APIs for the new Eclipse Platform Runtime achieve their final and stable form (post-3.0).
IPluginRegistry
public static IPath getPluginStateLocation(Plugin plugin)
The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings.
plugin
- the plug-in whose state location is returned
public static String getProtectionSpace(URL resourceUrl)
null
if the realm is unknown.
resourceUrl
- the URL of the resource whose protection space is
returned. For example, "http://www.example.com/folder/".
null
if the realm is unknownpublic static void removeLogListener(ILogListener listener)
listener
- the listener to deregisterILog.removeLogListener(org.eclipse.core.runtime.ILogListener)
,
addLogListener(org.eclipse.core.runtime.ILogListener)
public static URL resolve(URL url) throws IOException
url
- original plug-in-relative URL.
IOException
- if unable to resolve URLasLocalURL(java.net.URL)
,
IPluginDescriptor.getInstallURL()
public static void run(ISafeRunnable runnable)
public static IJobManager getJobManager()
public static IExtensionRegistry getExtensionRegistry()
IExtensionRegistry
public static URL find(org.osgi.framework.Bundle bundle, IPath path)
null
if the URL
could not be computed or created.
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the bundle in which to search
null
It is not
necessary to perform a 'resolve' on this URL.public static URL find(org.osgi.framework.Bundle b, IPath path, Map override)
null
if the URL
could not be computed or created.
find will look for this path under the directory structure for this plugin
and any of its fragments. If this path will yield a result outside the
scope of this plugin, null
will be returned. Note that
there is no specific order to the fragments.
The following arguments may also be used
$nl$ - for language specific information
$os$ - for operating system specific information
$ws$ - for windowing system specific information
A path of $nl$/about.properties in an environment with a default
locale of en_CA will return a URL corresponding to the first place
about.properties is found according to the following order:
plugin root/nl/en/CA/about.properties
fragment1 root/nl/en/CA/about.properties
fragment2 root/nl/en/CA/about.properties
...
plugin root/nl/en/about.properties
fragment1 root/nl/en/about.properties
fragment2 root/nl/en/about.properties
...
plugin root/about.properties
fragment1 root/about.properties
fragment2 root/about.properties
...
If a locale other than the default locale is desired, use an
override map.
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
path
- file path relative to plug-in installation locationoverride
- map of override substitution arguments to be used for
any $arg$ path elements. The map keys correspond to the substitution
arguments (eg. "$nl$" or "$os$"). The resulting
values must be of type java.lang.String. If the map is null
,
or does not contain the required substitution argument, the default
is used.
null
. It is not
necessary to perform a 'resolve' on this URL.public static InputStream openStream(org.osgi.framework.Bundle bundle, IPath file) throws IOException
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the bundle in which to searchfile
- path relative to plug-in installation location
IOException
openStream(Bundle, IPath, boolean)
public static InputStream openStream(org.osgi.framework.Bundle bundle, IPath file, boolean localized) throws IOException
The caller must close the returned stream when done.
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the bundle in which to searchfile
- path relative to plug-in installation locationlocalized
- true
for the localized version
of the file, and false
for the file exactly
as specified
IOException
public static IPath getStateLocation(org.osgi.framework.Bundle bundle)
The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings and other configuration parameters.
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the bundle whose state location if returned
public static ILog getLog(org.osgi.framework.Bundle bundle)
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the bundle whose log is returned
public static ResourceBundle getResourceBundle(org.osgi.framework.Bundle bundle) throws MissingResourceException
The resource bundle is stored as the plugin.properties
file
in the plug-in install directory, and contains any translatable
strings used in the plug-in manifest file (plugin.xml
)
along with other resource strings used by the plug-in implementation.
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
MissingResourceException
- if the resource bundle was not foundpublic static String getResourceString(org.osgi.framework.Bundle bundle, String value)
Equivalent to getResourceString(bundle, value, getResourceBundle())
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the runtime bundlevalue
- the value
getResourceBundle(org.osgi.framework.Bundle)
public static String getResourceString(org.osgi.framework.Bundle bundle, String value, ResourceBundle resourceBundle)
For example, assume resource bundle plugin.properties contains name = Project Name
getResourceString("Hello World") returns "Hello World" getResourceString("%name") returns "Project Name" getResourceString("%name Hello World") returns "Project Name" getResourceString("%abcd Hello World") returns "Hello World" getResourceString("%abcd") returns "%abcd" getResourceString("%%name") returns "%name"
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
bundle
- the runtime bundlevalue
- the value
getResourceBundle(org.osgi.framework.Bundle)
public static String getOSArch()
java.lang.System.getProperty("os.arch")
.
public static String getNL()
$nl$
.
public static String getOS()
$os$
. OS_UNKNOWN
is
returned if the operating system cannot be determined.
The value may indicate one of the operating systems known to the platform
(as specified in knownOSValues
) or a user-defined string if
the operating system name is specified on the command line.
#knownOSValues
public static String getWS()
$ws$
. null
is returned
if the window system cannot be determined.
null
public static String[] getAllArgs()
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
public static String[] getFrameworkArgs()
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
public static String[] getApplicationArgs()
Note: This is an early access API to the new OSGI-based Eclipse 3.0 Platform Runtime. Because the APIs for the new runtime have not yet been fully stabilized, they should only be used by clients needing to take particular advantage of new OSGI-specific functionality, and only then with the understanding that these APIs may well change in incompatible ways until they reach their finished, stable form (post-3.0).
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |